/*
 * Copyright 2012 Andrea Parodi
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package eban.storebyrules;

import eban.storebyrules.results.Result;

import java.sql.SQLException;

/**
 * This interface should be implemented by classes that
 * manages communication with a particular storage vendor.
 */
public interface Storage {

    /**
     * Execute a command that retrieve data
     * from the storage system.
     * <p>
     * This command return an implementation of Result
     * normally implemented specifically for this storage vendor.
     *
     * @param sql
     * @return
     */
    Result getRecords(String sql) throws SQLException;

    /**
     * Add a model to this DbManager. A model is
     * a class that allow to store and query data
     * for a singol class.
     *
     * @param documentClass
     * @param <Document>
     * @return
     */
    <Document> PersistentCollection<Document> addModel(Class<Document> documentClass);

    /**
     * Close this DbManager instance
     */
    void close();

    /**
     * Create a new Transaction and return it.
     */
    Transaction beginTransaction();

}
